/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_HELPERS_SOCKET_OUTPUT_STREAM_H
#define _LOG4CXX_HELPERS_SOCKET_OUTPUT_STREAM_H

#include <log4cxx/logstring.h>
#include <log4cxx/helpers/objectimpl.h>
#include <log4cxx/helpers/objectptr.h>

namespace log4cxx
{
        namespace helpers
        {
                class Socket;
                typedef ObjectPtrT<Socket> SocketPtr;

                class SocketOutputStream;
                typedef ObjectPtrT<SocketOutputStream> SocketOutputStreamPtr;

                class LOG4CXX_EXPORT SocketOutputStream : public ObjectImpl
                {
                public:
                        DECLARE_ABSTRACT_LOG4CXX_OBJECT(SocketOutputStream)
                        BEGIN_LOG4CXX_CAST_MAP()
                                LOG4CXX_CAST_ENTRY(SocketOutputStream)
                        END_LOG4CXX_CAST_MAP()

                        SocketOutputStream(SocketPtr socket);
                        ~SocketOutputStream();

                        void write(const void * buffer, size_t len);
                        void write(unsigned int value);
                        void write(int value);
                        void write(unsigned long value);
                        void write(long value);

                        /**
                         * Writes a LogString to a socket.
                         * The length of the string is written as the first
                         * two bytes to allow proper deserialization on the
                         * client side.
                         */
                        void write(const LogString& value);

                        /**
                         * Writes a LogString to a socket.
                         * Only the contents of the String itself are written,
                         * no length byte is passed to the client. This is 
                         * usefull when the client does not need to properly
                         * deserialize the String, such as raw telnet clients.
                         */
                        void writeRaw(const LogString& value);

                        // some write functions are missing ...

                        /** Close the stream and dereference the socket.
                        */
                        void close();

                        /** Flushes this output stream and forces any buffered output
                        bytes to be written out.
                        */
                        void flush();

                protected:
                        SocketPtr socket;

                        /** memory stream buffer */
/*       class membuf :
                                public std::basic_streambuf<char, std::char_traits<char> >
                        {
                        public:
                                const void * buffer() const;
                                const size_t size() const;
                        }*/

                        unsigned char * beg, * cur, * end;


                private:
                       //
                       //   prevent copy and assignment statements
                       SocketOutputStream(const SocketOutputStream&);
                       SocketOutputStream& operator=(const SocketOutputStream&);

                };
        }  // namespace helpers
} // namespace log4cxx

#endif // _LOG4CXX_HELPERS_SOCKET_OUTPUT_STREAM_H
